package net.xdclass.onlinexdclass.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * Swagger配置类
 * 在与spring boot集成时，放在与Application.java同级目录下
 *
 * @Api: 描述类/接口的主要用途
 * @ApiOperation:描述方法用途，给API增加说明
 * @ApiImplicitParam:描述方法的参数，给参数增加说明
 * @ApilmplicitParams:描述方法参数
 * @ApiIgnore: 或略某类/方法/参数的文档
 *
 *
 *
 */
@Profile({"dev", "test"})
@Configuration
@EnableSwagger2
public class Swagger2 {

    /**
     * 创建API应用
     * apilnfo()增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例，用来控制哪些接口暴露给Swagger来展现
     * http://localhost:8081/swagger-ui.html
     *
     */
    @Bean
    public Docket createRestApi() {

        //添加head参数token
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());


        //apis()配置包扫描路径，Swagger会扫描包下所有Controller定义的API,并产生文档内容。如果不想产生API，使用注释@ApiIgnore
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("net.xdclass.onlinexdclass.controller"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);
    }


    /**
     * 创建该API的基本信息(这些基本信息会展现在文档页面中)
     * 访问地址:http://项目实际地址/swagger-ui.html
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("RESTful APIs")
                .description("RESTful APIs")
                .termsOfServiceUrl("http://localhost:8081/")
                .contact("long")
                .version("1.0")
                .build();
    }

}
